home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 October: Mac OS SDK / Dev.CD Oct 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / StandardFile.p < prev    next >
Encoding:
Text File  |  1997-08-12  |  9.6 KB  |  285 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        StandardFile.p
  3.  
  4.      Contains:    Standard File package Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0.1
  8.  
  9.      Copyright:    © 1990-1997, 1997 by Apple Computer, Inc., all rights reserved
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT StandardFile;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __STANDARDFILE__}
  28. {$SETC __STANDARDFILE__ := 1}
  29.  
  30. {$I+}
  31. {$SETC StandardFileIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37. {$IFC UNDEFINED __DIALOGS__}
  38. {$I Dialogs.p}
  39. {$ENDC}
  40. {$IFC UNDEFINED __FILES__}
  41. {$I Files.p}
  42. {$ENDC}
  43.  
  44.  
  45. {$PUSH}
  46. {$ALIGN MAC68K}
  47. {$LibExport+}
  48.  
  49.  
  50. CONST
  51.                                                                 {  resource IDs of pre-7.0 get and put dialogs  }
  52.     putDlgID                    = -3999;
  53.     getDlgID                    = -4000;
  54.  
  55.                                                                 {  item offsets of pre-7.0 get and put dialogs  }
  56.     putSave                        = 1;
  57.     putCancel                    = 2;
  58.     putEject                    = 5;
  59.     putDrive                    = 6;
  60.     putName                        = 7;
  61.     getOpen                        = 1;
  62.     getCancel                    = 3;
  63.     getEject                    = 5;
  64.     getDrive                    = 6;
  65.     getNmList                    = 7;
  66.     getScroll                    = 8;
  67.  
  68.                                                                 {  resource IDs of 7.0 get and put dialogs  }
  69.     sfPutDialogID                = -6043;
  70.     sfGetDialogID                = -6042;
  71.  
  72.                                                                 {  item offsets of 7.0 get and put dialogs  }
  73.     sfItemOpenButton            = 1;
  74.     sfItemCancelButton            = 2;
  75.     sfItemBalloonHelp            = 3;
  76.     sfItemVolumeUser            = 4;
  77.     sfItemEjectButton            = 5;
  78.     sfItemDesktopButton            = 6;
  79.     sfItemFileListUser            = 7;
  80.     sfItemPopUpMenuUser            = 8;
  81.     sfItemDividerLinePict        = 9;
  82.     sfItemFileNameTextEdit        = 10;
  83.     sfItemPromptStaticText        = 11;
  84.     sfItemNewFolderUser            = 12;
  85.  
  86.                                                                 {  pseudo-item hits for use in DlgHook  }
  87.     sfHookFirstCall                = -1;
  88.     sfHookCharOffset            = $1000;
  89.     sfHookNullEvent                = 100;
  90.     sfHookRebuildList            = 101;
  91.     sfHookFolderPopUp            = 102;
  92.     sfHookOpenFolder            = 103;                            {  the following are only in system 7.0+  }
  93.     sfHookLastCall                = -2;
  94.     sfHookOpenAlias                = 104;
  95.     sfHookGoToDesktop            = 105;
  96.     sfHookGoToAliasTarget        = 106;
  97.     sfHookGoToParent            = 107;
  98.     sfHookGoToNextDrive            = 108;
  99.     sfHookGoToPrevDrive            = 109;
  100.     sfHookChangeSelection        = 110;
  101.     sfHookSetActiveOffset        = 200;
  102.  
  103.  
  104. { the refcon field of the dialog record during a
  105.  modalfilter or dialoghook contains one of the following }
  106.     sfMainDialogRefCon            = 'stdf';
  107.     sfNewFolderDialogRefCon        = 'nfdr';
  108.     sfReplaceDialogRefCon        = 'rplc';
  109.     sfStatWarnDialogRefCon        = 'stat';
  110.     sfLockWarnDialogRefCon        = 'lock';
  111.     sfErrorDialogRefCon            = 'err ';
  112.  
  113.  
  114.  
  115. TYPE
  116.     SFReplyPtr = ^SFReply;
  117.     SFReply = RECORD
  118.         good:                    BOOLEAN;
  119.         copy:                    BOOLEAN;
  120.         fType:                    OSType;
  121.         vRefNum:                INTEGER;
  122.         version:                INTEGER;
  123.         fName:                    Str63;
  124.     END;
  125.  
  126.     StandardFileReplyPtr = ^StandardFileReply;
  127.     StandardFileReply = RECORD
  128.         sfGood:                    BOOLEAN;
  129.         sfReplacing:            BOOLEAN;
  130.         sfType:                    OSType;
  131.         sfFile:                    FSSpec;
  132.         sfScript:                ScriptCode;
  133.         sfFlags:                INTEGER;
  134.         sfIsFolder:                BOOLEAN;
  135.         sfIsVolume:                BOOLEAN;
  136.         sfReserved1:            LONGINT;
  137.         sfReserved2:            INTEGER;
  138.     END;
  139.  
  140. { for CustomXXXFile, ActivationOrderListPtr parameter is a pointer to an array of item numbers }
  141.     ActivationOrderListPtr                = ^INTEGER;
  142.     DlgHookProcPtr = ProcPtr;  { FUNCTION DlgHook(item: INTEGER; theDialog: DialogPtr): INTEGER; }
  143.  
  144.     FileFilterProcPtr = ProcPtr;  { FUNCTION FileFilter(pb: CInfoPBPtr): BOOLEAN; }
  145.  
  146. { the following also include an extra parameter of "your data pointer" }
  147.     DlgHookYDProcPtr = ProcPtr;  { FUNCTION DlgHookYD(item: INTEGER; theDialog: DialogPtr; yourDataPtr: UNIV Ptr): INTEGER; }
  148.  
  149.     ModalFilterYDProcPtr = ProcPtr;  { FUNCTION ModalFilterYD(theDialog: DialogPtr; VAR theEvent: EventRecord; VAR itemHit: INTEGER; yourDataPtr: UNIV Ptr): BOOLEAN; }
  150.  
  151.     FileFilterYDProcPtr = ProcPtr;  { FUNCTION FileFilterYD(pb: CInfoPBPtr; yourDataPtr: UNIV Ptr): BOOLEAN; }
  152.  
  153.     ActivateYDProcPtr = ProcPtr;  { PROCEDURE ActivateYD(theDialog: DialogPtr; itemNo: INTEGER; activating: BOOLEAN; yourDataPtr: UNIV Ptr); }
  154.  
  155.     DlgHookUPP = UniversalProcPtr;
  156.     FileFilterUPP = UniversalProcPtr;
  157.     DlgHookYDUPP = UniversalProcPtr;
  158.     ModalFilterYDUPP = UniversalProcPtr;
  159.     FileFilterYDUPP = UniversalProcPtr;
  160.     ActivateYDUPP = UniversalProcPtr;
  161.  
  162. CONST
  163.     uppDlgHookProcInfo = $000003A0;
  164.     uppFileFilterProcInfo = $000000D0;
  165.     uppDlgHookYDProcInfo = $00000FA0;
  166.     uppModalFilterYDProcInfo = $00003FD0;
  167.     uppFileFilterYDProcInfo = $000003D0;
  168.     uppActivateYDProcInfo = $000036C0;
  169.  
  170. FUNCTION NewDlgHookProc(userRoutine: DlgHookProcPtr): DlgHookUPP;
  171.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  172.     INLINE $2E9F;
  173.     {$ENDC}
  174.  
  175. FUNCTION NewFileFilterProc(userRoutine: FileFilterProcPtr): FileFilterUPP;
  176.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  177.     INLINE $2E9F;
  178.     {$ENDC}
  179.  
  180. FUNCTION NewDlgHookYDProc(userRoutine: DlgHookYDProcPtr): DlgHookYDUPP;
  181.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  182.     INLINE $2E9F;
  183.     {$ENDC}
  184.  
  185. FUNCTION NewModalFilterYDProc(userRoutine: ModalFilterYDProcPtr): ModalFilterYDUPP;
  186.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  187.     INLINE $2E9F;
  188.     {$ENDC}
  189.  
  190. FUNCTION NewFileFilterYDProc(userRoutine: FileFilterYDProcPtr): FileFilterYDUPP;
  191.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  192.     INLINE $2E9F;
  193.     {$ENDC}
  194.  
  195. FUNCTION NewActivateYDProc(userRoutine: ActivateYDProcPtr): ActivateYDUPP;
  196.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  197.     INLINE $2E9F;
  198.     {$ENDC}
  199.  
  200. FUNCTION CallDlgHookProc(item: INTEGER; theDialog: DialogPtr; userRoutine: DlgHookUPP): INTEGER;
  201.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  202.     INLINE $205F, $4E90;
  203.     {$ENDC}
  204.  
  205. FUNCTION CallFileFilterProc(pb: CInfoPBPtr; userRoutine: FileFilterUPP): BOOLEAN;
  206.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  207.     INLINE $205F, $4E90;
  208.     {$ENDC}
  209.  
  210. FUNCTION CallDlgHookYDProc(item: INTEGER; theDialog: DialogPtr; yourDataPtr: UNIV Ptr; userRoutine: DlgHookYDUPP): INTEGER;
  211.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  212.     INLINE $205F, $4E90;
  213.     {$ENDC}
  214.  
  215. FUNCTION CallModalFilterYDProc(theDialog: DialogPtr; VAR theEvent: EventRecord; VAR itemHit: INTEGER; yourDataPtr: UNIV Ptr; userRoutine: ModalFilterYDUPP): BOOLEAN;
  216.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  217.     INLINE $205F, $4E90;
  218.     {$ENDC}
  219.  
  220. FUNCTION CallFileFilterYDProc(pb: CInfoPBPtr; yourDataPtr: UNIV Ptr; userRoutine: FileFilterYDUPP): BOOLEAN;
  221.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  222.     INLINE $205F, $4E90;
  223.     {$ENDC}
  224.  
  225. PROCEDURE CallActivateYDProc(theDialog: DialogPtr; itemNo: INTEGER; activating: BOOLEAN; yourDataPtr: UNIV Ptr; userRoutine: ActivateYDUPP);
  226.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  227.     INLINE $205F, $4E90;
  228.     {$ENDC}
  229.  
  230. TYPE
  231.     SFTypeList                            = ARRAY [0..3] OF OSType;
  232. {
  233.     The GetFile "typeList" parameter type has changed from "SFTypeList" to "ConstSFTypeListPtr".
  234.     For C, this will add "const" and make it an in-only parameter.
  235.     For Pascal, this will require client code to use the @ operator, but make it easier to specify long lists.
  236.  
  237.     ConstSFTypeListPtr is a pointer to an array of OSTypes.
  238. }
  239.     ConstSFTypeListPtr                    = ^OSType;
  240.  
  241. PROCEDURE SFPutFile(where: Point; prompt: ConstStr255Param; origName: ConstStr255Param; dlgHook: DlgHookUPP; VAR reply: SFReply);
  242.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  243.     INLINE $3F3C, $0001, $A9EA;
  244.     {$ENDC}
  245. PROCEDURE SFGetFile(where: Point; prompt: ConstStr255Param; fileFilter: FileFilterUPP; numTypes: INTEGER; typeList: ConstSFTypeListPtr; dlgHook: DlgHookUPP; VAR reply: SFReply);
  246.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  247.     INLINE $3F3C, $0002, $A9EA;
  248.     {$ENDC}
  249. PROCEDURE SFPPutFile(where: Point; prompt: ConstStr255Param; origName: ConstStr255Param; dlgHook: DlgHookUPP; VAR reply: SFReply; dlgID: INTEGER; filterProc: ModalFilterUPP);
  250.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  251.     INLINE $3F3C, $0003, $A9EA;
  252.     {$ENDC}
  253. PROCEDURE SFPGetFile(where: Point; prompt: ConstStr255Param; fileFilter: FileFilterUPP; numTypes: INTEGER; typeList: ConstSFTypeListPtr; dlgHook: DlgHookUPP; VAR reply: SFReply; dlgID: INTEGER; filterProc: ModalFilterUPP);
  254.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  255.     INLINE $3F3C, $0004, $A9EA;
  256.     {$ENDC}
  257. PROCEDURE StandardPutFile(prompt: ConstStr255Param; defaultName: ConstStr255Param; VAR reply: StandardFileReply);
  258.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  259.     INLINE $3F3C, $0005, $A9EA;
  260.     {$ENDC}
  261. PROCEDURE StandardGetFile(fileFilter: FileFilterUPP; numTypes: INTEGER; typeList: ConstSFTypeListPtr; VAR reply: StandardFileReply);
  262.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  263.     INLINE $3F3C, $0006, $A9EA;
  264.     {$ENDC}
  265. PROCEDURE CustomPutFile(prompt: ConstStr255Param; defaultName: ConstStr255Param; VAR reply: StandardFileReply; dlgID: INTEGER; where: Point; dlgHook: DlgHookYDUPP; filterProc: ModalFilterYDUPP; activeList: ActivationOrderListPtr; activate: ActivateYDUPP; yourDataPtr: UNIV Ptr);
  266.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  267.     INLINE $3F3C, $0007, $A9EA;
  268.     {$ENDC}
  269. PROCEDURE CustomGetFile(fileFilter: FileFilterYDUPP; numTypes: INTEGER; typeList: ConstSFTypeListPtr; VAR reply: StandardFileReply; dlgID: INTEGER; where: Point; dlgHook: DlgHookYDUPP; filterProc: ModalFilterYDUPP; activeList: ActivationOrderListPtr; activate: ActivateYDUPP; yourDataPtr: UNIV Ptr);
  270.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  271.     INLINE $3F3C, $0008, $A9EA;
  272.     {$ENDC}
  273. FUNCTION StandardOpenDialog(VAR reply: StandardFileReply): OSErr;
  274.  
  275. {$ALIGN RESET}
  276. {$POP}
  277.  
  278. {$SETC UsingIncludes := StandardFileIncludes}
  279.  
  280. {$ENDC} {__STANDARDFILE__}
  281.  
  282. {$IFC NOT UsingIncludes}
  283.  END.
  284. {$ENDC}
  285.